Components: Stop re-exporting experimental utilities from @wordpress/components
#62155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…he external re-export from `@wordpress-components` and start replacing app consumers to import it from `block-editor` Start with `hasSplitBorders`
fullofcaffeine
force-pushed
the
try/stop-exporting-helpers-from-wp-components
branch
from
a4af26d to
6c951ba
Compare
|
Size Change: +52 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
fullofcaffeine
commented
May 30, 2024
| @@ -35,6 +35,7 @@ export { | |||
|
|
|||
| export { default as __experimentalStyleProvider } from './style-provider'; | |||
| export { default as BaseControl } from './base-control'; | |||
| // @todo review this RN export | |||
| export { hasSplitBorders as __experimentalHasSplitBorders } from './border-box-control/utils'; | |||
There was a problem hiding this comment.
I don't know much about our RN setup. If we go with the approach in this PR, should we also remove this and copy it over closer to where the native is? I'm not sure if we should also remove it from RN at this point. I did search throughout GB, and it also looks like it's not being used by RN consumers in the codebase, but I'm not sure if it could be used by other third-party RN packages.
There was a problem hiding this comment.
@dcalhoun @WordPress/native-mobile can you please confirm that it's safe to remove this export? Thank you! 🙏
There was a problem hiding this comment.
👋🏻 Thanks for the ping.
The mobile unit tests are passing on the CI server, so that is a good sign. 😄 I did not encountering any issues after checking out the proposed changes and "smoke testing" the editor on an iPhone simulator.
From quickly reviewing the related code, my perception is that __experimentalHasSplitBorders is not utilized by the native mobile editor. So, removing this export should likely be safe.
|
Taking over. |
ciampo
reviewed
Jun 21, 2024
| @@ -175,3 +175,5 @@ export { useBlockCommands } from './use-block-commands'; | |||
| * The following rename hint component can be removed in 6.4. | |||
| */ | |||
| export { default as ReusableBlocksRenameHint } from './inserter/reusable-block-rename-hint'; | |||
|
|
|||
| export * from './border-box-utils'; | |||
There was a problem hiding this comment.
Would the packages/block-editor/src/utils be a better folder instead of the components folder for these utils?
This time you beat me to it! I'll be happily help with reviews on this one. I'll also add a label re. leaving a dev note for devs who may be experiencing breakages, recommending they import those same utils from the |
ciampo
added
the
Needs Dev Note
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: #61135
Related: #59418
What?
@wordpress/components;Why?
There are a few exports from
@wordpress/componentsthat smell, more specifically the ones listed in the aforementioned issue. These are utilities/helper functions that were developed as part of theBorderBoxcomponent but that ended up leaking to other packages in the Gutenberg app. The main problem here is that the wp-components package is not the best place to export shared utilities like this from.This PR attempts to start solving that by first identifying where else in Gutenberg those utilities were being used, and copying them over to a tidy-up module in a package that makes more sense to them, which, as per @DaniGuardiola's initial analysis, would be
block-editor(see the linked issue).Later, we might DRY all these and other semantically related utilities (see the issue) into a single package that can be shared between multiple packages, including wp-components. This will be discussed and done in a follow-up.
How?
isDefinedBorderandhasSplitBordersto a module inblock-ediotr/components/border-box-utils;tsconfig.jsonto support the module;isEmptyBorderfrom the new module as it's not being used outside of wp-components and in this case is only used internally.Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast
TODO